/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   21.08.2015 (thor): created
 */
package org.knime.core.data.time.period;

import java.time.Period;
import java.time.format.DateTimeParseException;

import org.knime.core.data.DataCell;
import org.knime.core.data.DataCellFactory.FromComplexString;
import org.knime.core.data.DataCellFactory.FromSimpleString;
import org.knime.core.data.DataType;
import org.knime.core.data.convert.DataCellFactoryMethod;
import org.knime.core.node.util.CheckUtils;
import org.knime.time.util.DurationPeriodFormatUtils;

/**
 * Factory for creating {@link PeriodCell}.
 *
 * @author Simon Schmid, KNIME.com, Konstanz, Germany
 * @since 3.3
 */
public final class PeriodCellFactory implements FromSimpleString, FromComplexString {
    /**
     * The data type for the cells created by this factory.
     */
    public static final DataType TYPE = PeriodCell.TYPE;

    @Override
    public DataType getDataType() {
        return TYPE;
    }

    @DataCellFactoryMethod(name = "String (PnYnMnD)")
    @Override
    public DataCell createCell(final String s) {
        return create(s);
    }

    /**
     * Creates a new PeriodCell from a string such as "PT20.345S".
     * For details see {@link Period#parse(CharSequence)}.
     * @param s the string to parse into {@link PeriodCell}, not null.
     * @return the cell containing the parsed Period.
     * @throws IllegalArgumentException when the string is null.
     * @throws DateTimeParseException as per {@link Period#parse(CharSequence)}
     */
    public static DataCell create(final String s) {
        return create(
            DurationPeriodFormatUtils.parsePeriod(CheckUtils.checkArgumentNotNull(s, "Argument must not be null")));
    }

    /**
     * Creates a new PeriodCell from the argument.
     * @param period Non-null argument to wrap.
     * @return the cell containing the parsed Period.
     * @throws IllegalArgumentException when the argument is null.
     */
    @DataCellFactoryMethod(name = "Period")
    public static DataCell create(final Period period) {
        return new PeriodCell(CheckUtils.checkArgumentNotNull(period, "Argument must not be null"));
    }

}
